home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_HDF.idb / usr / freeware / include / hdf / hdf.h.z / hdf.h
Encoding:
C/C++ Source or Header  |  1999-01-26  |  4.8 KB  |  172 lines
  1.  
  2. /****************************************************************************
  3.  * NCSA HDF                                                                 *
  4.  * Software Development Group                                               *
  5.  * National Center for Supercomputing Applications                          *
  6.  * University of Illinois at Urbana-Champaign                               *
  7.  * 605 E. Springfield, Champaign IL 61820                                   *
  8.  *                                                                          *
  9.  * For conditions of distribution and use, see the accompanying             *
  10.  * hdf/COPYING file.                                                        *
  11.  *                                                                          *
  12.  ****************************************************************************/
  13.  
  14. /* $Id: hdf.h,v 1.59 1998/02/20 19:25:10 koziol Exp $ */
  15.  
  16. #ifndef HDF_H
  17. #define HDF_H
  18.  
  19. #include "hdfi.h"
  20. #include "hlimits.h"
  21.  
  22. /* Internal DF structure */
  23. typedef struct
  24.   {
  25.       uint16      tag;          /* tag of element */
  26.       uint16      ref;          /* ref of element */
  27.   }
  28. DFdi;
  29.  
  30. /* For annotations */
  31. /* enumerated types of the varous annotation types */
  32. typedef enum 
  33. { 
  34.     AN_UNDEF = -1,
  35.     AN_DATA_LABEL = 0, /* Data label */
  36.     AN_DATA_DESC,      /* Data description */
  37.     AN_FILE_LABEL,     /* File label */
  38.     AN_FILE_DESC       /* File description */
  39. } ann_type;
  40.  
  41. /* internal file access codes */
  42.  
  43. #define DFACC_READ 1
  44. #define DFACC_WRITE 2
  45. #define DFACC_CREATE 4
  46. #define DFACC_ALL 7
  47.  
  48. #define DFACC_RDONLY 1
  49. #define DFACC_RDWR 3
  50. #define DFACC_CLOBBER 4
  51.  
  52. /* New file access codes (for Hstartaccess only, currently) */
  53. #define DFACC_BUFFER 8  /* buffer the access to this AID */
  54. #define DFACC_APPENDABLE 0x10 /* make this AID appendable */
  55. #define DFACC_CURRENT 0x20 /* start looking for a tag/ref from the current */
  56.                /* location in the DD list (useful for continued */
  57.                /* searching ala findfirst/findnext) */
  58.  
  59. /* External Element File access mode */
  60. /* #define DFACC_CREATE 4    is for creating new external element file */
  61. #define DFACC_OLD    1    /* for accessing existing ext. element file */
  62.  
  63. /* The magic cookie for Hcache to cache all files */
  64. #define CACHE_ALL_FILES (-2)
  65.  
  66. /* File access modes */
  67. /* 001--007 for different serial modes */
  68. /* 011--017 for different parallel modes */
  69.  
  70. #define DFACC_DEFAULT   000
  71. #define DFACC_SERIAL    001
  72. #define DFACC_PARALLEL  011
  73.  
  74. /* used by Hnextread to determine where to start searching for the
  75.    next tag/ref to read */
  76.  
  77. #define DF_START 0
  78. #define DF_CURRENT 1
  79. #define DF_END 2
  80.  
  81. /* Used by Hfind to determine the direction to search for tag/ref's in the */
  82. /* file. */
  83.  
  84. #define DF_FORWARD  1
  85. #define DF_BACKWARD 2
  86.  
  87. /* return code - since some unix/c routines use 0 and -1 as their return
  88.    code, and some assumption had been made in the code about that, it is
  89.    important to keep these constants the same values.  For explicitly
  90.    boolean functions, use TRUE and FALSE */
  91.  
  92. #define SUCCEED 0
  93. #define FAIL (-1)
  94.  
  95. /* boolean values,  reminder: NEVER compare with numeric values */
  96.  
  97. #ifndef FALSE
  98. #   define FALSE 0
  99. #endif
  100. #ifndef TRUE
  101. #   define TRUE (!FALSE)
  102. #endif
  103.  
  104. #ifndef NULL
  105. #   define NULL (void *)0
  106. #endif
  107.  
  108. /* macros */
  109. #define STREQ(s, t) (HDstrcmp((s), (t)) == 0)
  110. #define NSTREQ(s, t, n) (HDstrncmp((s), (t), (n)) == 0)
  111.  
  112. /*
  113.  * Macros used for variable and function scoping in code.....
  114.  */
  115. #ifndef EXPORT
  116. #define EXPORT
  117. #endif
  118.  
  119. #ifndef PRIVATE
  120. #define PRIVATE static
  121. #endif
  122.  
  123. /* Include the Number-type definitions */
  124. #include "hntdefs.h"
  125.  
  126. /* Include the Tag definitions */
  127. #include "htags.h"
  128.  
  129. /*
  130.    * interlacing supported by the vset.
  131.  */
  132.  
  133. #define FULL_INTERLACE  0
  134. #define NO_INTERLACE    1
  135.  
  136. /* type for File ID to send to Hlevel from Vxx interface */
  137. typedef int32 HFILEID;
  138.  
  139. typedef intn (*hdf_termfunc_t)(void);   /* termination function typedef */
  140.  
  141. /* .................................................................. */
  142.  
  143. /* Publically accessible functions declarations.  This includes all the
  144.    functions that are used by application programs.  */
  145.  
  146. #include "hbitio.h"
  147. #include "hcomp.h"
  148. #include "herr.h"
  149. #include "hproto.h"
  150. #include "vg.h"         /* Add the Vgroup/Vdata header so the users don't have to */
  151. #include "mfgr.h"       /* Add the GR header so the users don't have to */
  152.  
  153. /* For Pablo Instrumentation */
  154. #ifdef HAVE_PABLO
  155. #include "ProcIDs.h"
  156. #endif /* PABLO */
  157.  
  158. /* these may eventaully evolve into real-life functions but not yet */
  159. #define HDFopen(f,a,d)      Hopen((f), (a), (d))
  160. #define HDFclose(f,a,d)     Hclose((f), (a), (d))
  161. #define Vstart(f)           Vinitialize((f))
  162. #define Vend(f)             Vfinish((f))
  163.  
  164. /* Misc. macros for backward compability */
  165. #define HDgettagname(tag)   HDgettagdesc(tag)
  166.  
  167. /* This is also defined in fmpio.h */
  168. #define MP_PAGEALL    0x01  /* page the whole file i.e. no limit on 'maxcache'*/
  169.  
  170. #endif /* HDF_H */
  171.  
  172.